home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / lib / python2.5 / email / header.pyc (.txt) < prev    next >
Python Compiled Bytecode  |  2008-10-29  |  14KB  |  405 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.5)
  3.  
  4. '''Header encoding and decoding functionality.'''
  5. __all__ = [
  6.     'Header',
  7.     'decode_header',
  8.     'make_header']
  9. import re
  10. import binascii
  11. import email.quoprimime as email
  12. import email.base64mime as email
  13. from email.errors import HeaderParseError
  14. from email.charset import Charset
  15. NL = '\n'
  16. SPACE = ' '
  17. USPACE = u' '
  18. SPACE8 = ' ' * 8
  19. UEMPTYSTRING = u''
  20. MAXLINELEN = 76
  21. USASCII = Charset('us-ascii')
  22. UTF8 = Charset('utf-8')
  23. ecre = re.compile('\n  =\\?                   # literal =?\n  (?P<charset>[^?]*?)   # non-greedy up to the next ? is the charset\n  \\?                    # literal ?\n  (?P<encoding>[qb])    # either a "q" or a "b", case insensitive\n  \\?                    # literal ?\n  (?P<encoded>.*?)      # non-greedy up to the next ?= is the encoded string\n  \\?=                   # literal ?=\n  (?=[ \\t]|$)           # whitespace or the end of the string\n  ', re.VERBOSE | re.IGNORECASE | re.MULTILINE)
  24. fcre = re.compile('[\\041-\\176]+:$')
  25. _max_append = email.quoprimime._max_append
  26.  
  27. def decode_header(header):
  28.     '''Decode a message header value without converting charset.
  29.  
  30.     Returns a list of (decoded_string, charset) pairs containing each of the
  31.     decoded parts of the header.  Charset is None for non-encoded parts of the
  32.     header, otherwise a lower-case string containing the name of the character
  33.     set specified in the encoded string.
  34.  
  35.     An email.Errors.HeaderParseError may be raised when certain decoding error
  36.     occurs (e.g. a base64 decoding exception).
  37.     '''
  38.     header = str(header)
  39.     if not ecre.search(header):
  40.         return [
  41.             (header, None)]
  42.     
  43.     decoded = []
  44.     dec = ''
  45.     for line in header.splitlines():
  46.         if not ecre.search(line):
  47.             decoded.append((line, None))
  48.             continue
  49.         
  50.         parts = ecre.split(line)
  51.         while parts:
  52.             unenc = parts.pop(0).strip()
  53.             if unenc:
  54.                 if decoded and decoded[-1][1] is None:
  55.                     decoded[-1] = (decoded[-1][0] + SPACE + unenc, None)
  56.                 else:
  57.                     decoded.append((unenc, None))
  58.             
  59.             if parts:
  60.                 (charset, encoding) = [ s.lower() for s in parts[0:2] ]
  61.                 encoded = parts[2]
  62.                 dec = None
  63.                 [] if encoding == 'q' else []
  64.                 if dec is None:
  65.                     dec = encoded
  66.                 
  67.                 if decoded and decoded[-1][1] == charset:
  68.                     decoded[-1] = (decoded[-1][0] + dec, decoded[-1][1])
  69.                 else:
  70.                     decoded.append((dec, charset))
  71.             
  72.             del parts[0:3]
  73.     
  74.     return decoded
  75.  
  76.  
  77. def make_header(decoded_seq, maxlinelen = None, header_name = None, continuation_ws = ' '):
  78.     '''Create a Header from a sequence of pairs as returned by decode_header()
  79.  
  80.     decode_header() takes a header value string and returns a sequence of
  81.     pairs of the format (decoded_string, charset) where charset is the string
  82.     name of the character set.
  83.  
  84.     This function takes one of those sequence of pairs and returns a Header
  85.     instance.  Optional maxlinelen, header_name, and continuation_ws are as in
  86.     the Header constructor.
  87.     '''
  88.     h = Header(maxlinelen = maxlinelen, header_name = header_name, continuation_ws = continuation_ws)
  89.     for s, charset in decoded_seq:
  90.         if charset is not None and not isinstance(charset, Charset):
  91.             charset = Charset(charset)
  92.         
  93.         h.append(s, charset)
  94.     
  95.     return h
  96.  
  97.  
  98. class Header:
  99.     
  100.     def __init__(self, s = None, charset = None, maxlinelen = None, header_name = None, continuation_ws = ' ', errors = 'strict'):
  101.         """Create a MIME-compliant header that can contain many character sets.
  102.  
  103.         Optional s is the initial header value.  If None, the initial header
  104.         value is not set.  You can later append to the header with .append()
  105.         method calls.  s may be a byte string or a Unicode string, but see the
  106.         .append() documentation for semantics.
  107.  
  108.         Optional charset serves two purposes: it has the same meaning as the
  109.         charset argument to the .append() method.  It also sets the default
  110.         character set for all subsequent .append() calls that omit the charset
  111.         argument.  If charset is not provided in the constructor, the us-ascii
  112.         charset is used both as s's initial charset and as the default for
  113.         subsequent .append() calls.
  114.  
  115.         The maximum line length can be specified explicit via maxlinelen.  For
  116.         splitting the first line to a shorter value (to account for the field
  117.         header which isn't included in s, e.g. `Subject') pass in the name of
  118.         the field in header_name.  The default maxlinelen is 76.
  119.  
  120.         continuation_ws must be RFC 2822 compliant folding whitespace (usually
  121.         either a space or a hard tab) which will be prepended to continuation
  122.         lines.
  123.  
  124.         errors is passed through to the .append() call.
  125.         """
  126.         if charset is None:
  127.             charset = USASCII
  128.         
  129.         if not isinstance(charset, Charset):
  130.             charset = Charset(charset)
  131.         
  132.         self._charset = charset
  133.         self._continuation_ws = continuation_ws
  134.         cws_expanded_len = len(continuation_ws.replace('\t', SPACE8))
  135.         self._chunks = []
  136.         if s is not None:
  137.             self.append(s, charset, errors)
  138.         
  139.         if maxlinelen is None:
  140.             maxlinelen = MAXLINELEN
  141.         
  142.         if header_name is None:
  143.             self._firstlinelen = maxlinelen
  144.         else:
  145.             self._firstlinelen = maxlinelen - len(header_name) - 2
  146.         self._maxlinelen = maxlinelen - cws_expanded_len
  147.  
  148.     
  149.     def __str__(self):
  150.         '''A synonym for self.encode().'''
  151.         return self.encode()
  152.  
  153.     
  154.     def __unicode__(self):
  155.         '''Helper for the built-in unicode function.'''
  156.         uchunks = []
  157.         lastcs = None
  158.         for s, charset in self._chunks:
  159.             nextcs = charset
  160.             if uchunks:
  161.                 if lastcs not in (None, 'us-ascii'):
  162.                     if nextcs in (None, 'us-ascii'):
  163.                         uchunks.append(USPACE)
  164.                         nextcs = None
  165.                     
  166.                 elif nextcs not in (None, 'us-ascii'):
  167.                     uchunks.append(USPACE)
  168.                 
  169.             
  170.             lastcs = nextcs
  171.             uchunks.append(unicode(s, str(charset)))
  172.         
  173.         return UEMPTYSTRING.join(uchunks)
  174.  
  175.     
  176.     def __eq__(self, other):
  177.         return other == self.encode()
  178.  
  179.     
  180.     def __ne__(self, other):
  181.         return not (self == other)
  182.  
  183.     
  184.     def append(self, s, charset = None, errors = 'strict'):
  185.         """Append a string to the MIME header.
  186.  
  187.         Optional charset, if given, should be a Charset instance or the name
  188.         of a character set (which will be converted to a Charset instance).  A
  189.         value of None (the default) means that the charset given in the
  190.         constructor is used.
  191.  
  192.         s may be a byte string or a Unicode string.  If it is a byte string
  193.         (i.e. isinstance(s, str) is true), then charset is the encoding of
  194.         that byte string, and a UnicodeError will be raised if the string
  195.         cannot be decoded with that charset.  If s is a Unicode string, then
  196.         charset is a hint specifying the character set of the characters in
  197.         the string.  In this case, when producing an RFC 2822 compliant header
  198.         using RFC 2047 rules, the Unicode string will be encoded using the
  199.         following charsets in order: us-ascii, the charset hint, utf-8.  The
  200.         first character set not to provoke a UnicodeError is used.
  201.  
  202.         Optional `errors' is passed as the third argument to any unicode() or
  203.         ustr.encode() call.
  204.         """
  205.         if charset is None:
  206.             charset = self._charset
  207.         elif not isinstance(charset, Charset):
  208.             charset = Charset(charset)
  209.         
  210.         if charset != '8bit':
  211.             if isinstance(s, str):
  212.                 if not charset.input_codec:
  213.                     pass
  214.                 incodec = 'us-ascii'
  215.                 ustr = unicode(s, incodec, errors)
  216.                 if not charset.output_codec:
  217.                     pass
  218.                 outcodec = 'us-ascii'
  219.                 ustr.encode(outcodec, errors)
  220.             elif isinstance(s, unicode):
  221.                 for charset in (USASCII, charset, UTF8):
  222.                     
  223.                     try:
  224.                         if not charset.output_codec:
  225.                             pass
  226.                         outcodec = 'us-ascii'
  227.                         s = s.encode(outcodec, errors)
  228.                     continue
  229.                     except UnicodeError:
  230.                         continue
  231.                     
  232.  
  233.                 elif not False:
  234.                     raise AssertionError, 'utf-8 conversion failed'
  235.                 None<EXCEPTION MATCH>UnicodeError
  236.             
  237.         
  238.         self._chunks.append((s, charset))
  239.  
  240.     
  241.     def _split(self, s, charset, maxlinelen, splitchars):
  242.         splittable = charset.to_splittable(s)
  243.         encoded = charset.from_splittable(splittable, True)
  244.         elen = charset.encoded_header_len(encoded)
  245.         if elen <= maxlinelen:
  246.             return [
  247.                 (encoded, charset)]
  248.         
  249.         if charset == '8bit':
  250.             return [
  251.                 (s, charset)]
  252.         elif charset == 'us-ascii':
  253.             return self._split_ascii(s, charset, maxlinelen, splitchars)
  254.         elif elen == len(s):
  255.             splitpnt = maxlinelen
  256.             first = charset.from_splittable(splittable[:splitpnt], False)
  257.             last = charset.from_splittable(splittable[splitpnt:], False)
  258.         else:
  259.             (first, last) = _binsplit(splittable, charset, maxlinelen)
  260.         fsplittable = charset.to_splittable(first)
  261.         fencoded = charset.from_splittable(fsplittable, True)
  262.         chunk = [
  263.             (fencoded, charset)]
  264.         return chunk + self._split(last, charset, self._maxlinelen, splitchars)
  265.  
  266.     
  267.     def _split_ascii(self, s, charset, firstlen, splitchars):
  268.         chunks = _split_ascii(s, firstlen, self._maxlinelen, self._continuation_ws, splitchars)
  269.         return zip(chunks, [
  270.             charset] * len(chunks))
  271.  
  272.     
  273.     def _encode_chunks(self, newchunks, maxlinelen):
  274.         chunks = []
  275.         for header, charset in newchunks:
  276.             if not header:
  277.                 continue
  278.             
  279.             if charset is None or charset.header_encoding is None:
  280.                 s = header
  281.             else:
  282.                 s = charset.header_encode(header)
  283.             if chunks and chunks[-1].endswith(' '):
  284.                 extra = ''
  285.             else:
  286.                 extra = ' '
  287.             _max_append(chunks, s, maxlinelen, extra)
  288.         
  289.         joiner = NL + self._continuation_ws
  290.         return joiner.join(chunks)
  291.  
  292.     
  293.     def encode(self, splitchars = ';, '):
  294.         """Encode a message header into an RFC-compliant format.
  295.  
  296.         There are many issues involved in converting a given string for use in
  297.         an email header.  Only certain character sets are readable in most
  298.         email clients, and as header strings can only contain a subset of
  299.         7-bit ASCII, care must be taken to properly convert and encode (with
  300.         Base64 or quoted-printable) header strings.  In addition, there is a
  301.         75-character length limit on any given encoded header field, so
  302.         line-wrapping must be performed, even with double-byte character sets.
  303.  
  304.         This method will do its best to convert the string to the correct
  305.         character set used in email, and encode and line wrap it safely with
  306.         the appropriate scheme for that character set.
  307.  
  308.         If the given charset is not known or an error occurs during
  309.         conversion, this function will return the header untouched.
  310.  
  311.         Optional splitchars is a string containing characters to split long
  312.         ASCII lines on, in rough support of RFC 2822's `highest level
  313.         syntactic breaks'.  This doesn't affect RFC 2047 encoded lines.
  314.         """
  315.         newchunks = []
  316.         maxlinelen = self._firstlinelen
  317.         lastlen = 0
  318.         for s, charset in self._chunks:
  319.             targetlen = maxlinelen - lastlen - 1
  320.             if targetlen < charset.encoded_header_len(''):
  321.                 targetlen = maxlinelen
  322.             
  323.             newchunks += self._split(s, charset, targetlen, splitchars)
  324.             (lastchunk, lastcharset) = newchunks[-1]
  325.             lastlen = lastcharset.encoded_header_len(lastchunk)
  326.         
  327.         return self._encode_chunks(newchunks, maxlinelen)
  328.  
  329.  
  330.  
  331. def _split_ascii(s, firstlen, restlen, continuation_ws, splitchars):
  332.     lines = []
  333.     maxlen = firstlen
  334.     for line in s.splitlines():
  335.         line = line.lstrip()
  336.         if len(line) < maxlen:
  337.             lines.append(line)
  338.             maxlen = restlen
  339.             continue
  340.         
  341.         for ch in splitchars:
  342.             if ch in line:
  343.                 break
  344.                 continue
  345.         else:
  346.             maxlen = restlen
  347.         cre = re.compile('%s\\s*' % ch)
  348.         if ch in ';,':
  349.             eol = ch
  350.         else:
  351.             eol = ''
  352.         joiner = eol + ' '
  353.         joinlen = len(joiner)
  354.         wslen = len(continuation_ws.replace('\t', SPACE8))
  355.         this = []
  356.         linelen = 0
  357.         for part in cre.split(line):
  358.             curlen = linelen + max(0, len(this) - 1) * joinlen
  359.             partlen = len(part)
  360.             onfirstline = not lines
  361.             if ch == ' ' and onfirstline and len(this) == 1 and fcre.match(this[0]):
  362.                 this.append(part)
  363.                 linelen += partlen
  364.                 continue
  365.             if curlen + partlen > maxlen:
  366.                 if this:
  367.                     lines.append(joiner.join(this) + eol)
  368.                 
  369.                 if partlen > maxlen and ch != ' ':
  370.                     subl = _split_ascii(part, maxlen, restlen, continuation_ws, ' ')
  371.                     lines.extend(subl[:-1])
  372.                     this = [
  373.                         subl[-1]]
  374.                 else:
  375.                     this = [
  376.                         part]
  377.                 linelen = wslen + len(this[-1])
  378.                 maxlen = restlen
  379.                 continue
  380.             this.append(part)
  381.             linelen += partlen
  382.         
  383.         if this:
  384.             lines.append(joiner.join(this))
  385.             continue
  386.     
  387.     return lines
  388.  
  389.  
  390. def _binsplit(splittable, charset, maxlinelen):
  391.     i = 0
  392.     j = len(splittable)
  393.     while i < j:
  394.         m = i + j + 1 >> 1
  395.         chunk = charset.from_splittable(splittable[:m], True)
  396.         chunklen = charset.encoded_header_len(chunk)
  397.         if chunklen <= maxlinelen:
  398.             i = m
  399.             continue
  400.         j = m - 1
  401.     first = charset.from_splittable(splittable[:i], False)
  402.     last = charset.from_splittable(splittable[i:], False)
  403.     return (first, last)
  404.  
  405.